Retrieve all performance metrics dashboards.

GET 
/visualization/dashboards

This endpoint retrieves all available dashboards containing performance metrics details. The data returned includes information such as dashboard IDs, names, category, and their configurations.

Request

Responses

200

Successfully retrieved the list of dashboards containing performance metrics details.

application/json

Schema

Schema

oneOf
Dashboard_GetAll_Response
response-code integer
status string
result object[]
Array [
Network object[]
Array [
dashboard.name string
dashboard.category string
dashboard.access.type string
dashboard.users integer[]
dashboard.context object
dashboard.widgets object[]
Array [
id integer
x integer
y integer
h integer
w integer
]
id integer
]
Server object[]
Array [
dashboard.name string
dashboard.category string
dashboard.access.type string
dashboard.users integer[]
dashboard.context object
dashboard.widgets object[]
Array [
id integer
x integer
y integer
h integer
w integer
]
id integer
]
]
Dashboard_GetAll_Response
response-code integer
status string
result object[]
Array [
Network object[]
Array [
dashboard.name string
dashboard.category string
dashboard.access.type string
dashboard.users integer[]
dashboard.context object
dashboard.widgets object[]
Array [
id integer
x integer
y integer
h integer
w integer
]
id integer
]
Server object[]
Array [
dashboard.name string
dashboard.category string
dashboard.access.type string
dashboard.users integer[]
dashboard.context object
dashboard.widgets object[]
Array [
id integer
x integer
y integer
h integer
w integer
]
id integer
]
]

Example (from schema)

{
  "response-code": 200,
  "status": "succeed",
  "result": [
    {
      "Network": [
        {
          "dashboard.name": "Up devices dashboard",
          "dashboard.category": "Network",
          "dashboard.access.type": "public",
          "dashboard.users": [1222223],
          "dashboard.context": {
            "dashboard.widgets": [
              {"id": 51001190939, "x": 0, "y": 0, "h": 7, "w": 10}
            ]
          },
          "id": 51001190938
        }
      ],
      "Server": [
        {
          "dashboard.name": "Server Overview",
          "dashboard.category": "Server",
          "dashboard.access.type": "public",
          "dashboard.users": [1222223],
          "dashboard.context": {
            "dashboard.widgets": [
              {"id": 51001190940, "x": 0, "y": 0, "h": 7, "w": 10}
            ]
          },
          "id": 51001190941
        }
      ]
    }
  ]
}

400

The request was invalid. Possible reasons could include missing required parameters or incorrect parameter values.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

The client is not authorized to access this resource. Ensure that the correct permissions are granted.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

An unexpected error occurred on the server. This might be due to a temporary issue or a problem with the request processing.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...